LogDoor User's Guide

Appendix 2 - File Formats

This appendix describes the formats of LogDoor's input and output files.

Input log file

The input log file to LogDoor must be a TEXT file in standard WebSTAR, AppleShare IP or other WebSTAR-compatible log file format, or HomeDoor log format. Each of these formats consist of a series of entries, with each entry terminated by a single return character (ASCII $0D). Fields within an entry are terminated by a single tab character (ASCII $09). WebSTAR-compatible log format consists of precisely the following fields in the following order:

Date - the date is always in mm/dd/yy format, with two digits each for the month, day and year. LogDoor recognizes dates of this form as follows:
- if yy > 80, the year is taken to be 19yy
- if yy <= 80, the year is taken to be 20yy
Time - the time is always in 24 hour format hh:mm:ss, with two digits each for the hour, minute and second.
Status - either "OK" indicating a successful access, "ERR!" indicating an error on access (usually an invalid URL), or "PRIV" indicating access to a password-protected URL. Note that traditionally the "OK" status code is followed by two space characters: "OK ".
IP address - the IP address (or domain name, if the server is using DNS lookups to replace IP addresses with domain names) of the requesting machine.
URL - the URL which was accessed. This field always begins with a colon, and uses colons to delimit directory names.
Number of bytes transferred.

The HomeDoor log format is described in the chapter HomeDoor-specific Processing.

The more general WebSTAR log format is somewhat complex. A WebSTAR log can consist of any of a number of fields in any order desired by the WebSTAR administrator. A WebSTAR log begins with a log format line which indicates the precise fields in any entries which follow that line. Subsequent formatting lines can appear anywhere within the file. A format line always begins with two exclamation point characters (!!). Details of the WebSTAR log format are described in the WebSTAR Users' Guide.

NOTE: A bug in WebSTAR versions prior to 1.3 could result in logs being written which do not begin with a log format line. LogDoor will usually be able to interpret such log files correctly anyway. Under some rare conditions, if you use an unusual log file format and encounter this bug, you may manually need to add a log format line to the log, using a text editor.

Output log files

LogDoor can produce one output log file for each site encountered in the input log file. Such output log files will always have the same format as the input log file.

Output HTML-formatted summary reports

LogDoor's HTML-formatted reports consist of a header and a day-by-day access table. Detailed information for the last 90 days is included, plus a summary of all information before that period. If a line graph URL has been specified, a line graph is included with each table entry. The overall report also includes a site-by-site access table, with each site name acting as a link to the individual report for that site. The general format of the site-specific reports is as follows:

<HTML>
<HEAD>
<TITLE>site1 Summary</TITLE>
</HEAD>
<BODY>
<CENTER><B>LogDoor Statistics Summary</B></CENTER> ***This line is replaced with Heading.html *** 
<CENTER><B>Summary Prepared: 06/20/97 06:54<BR>
Site: site1<BR>
</B><P>
<B>Daily Totals</B><P>
<TABLE BORDER CELLSPACING=2>
<TR ALIGN=CENTER>
<TD WIDTH=50><B>Date</B></TD>
<TD COLSPAN=2><B>Hits</B></TD>
<TD WIDTH=50><B>Bytes</B></TD>
<TD WIDTH=50><B>Errors</B></TD>
</TR><P>
<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>6/1/97</TD>
<TD>3</TD>
<TD><IMG ALIGN=LEFT SRC="line.gif" WIDTH="27" HEIGHT="10"></TD><TD>10K</TD>
<TD>0</TD>
</TR><P>

etc.

<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>Totals</TD>
<TD>43</TD>
<TD>&nbsp;</TD><TD>113K</TD>
<TD>1</TD>
</TR><P>
</TABLE><P>
</CENTER></BODY>
</HTML>

Sample reports are available on the LogDoor Web pages.

Output text-formatted summary reports

LogDoor's text-formatted reports contain equivalent information to that in the HTML-formatted reports, however fields are tab-delimited rather than being included in a table. Such reports should be directly importable into any spreadsheet application. The general format of these reports is as follows:

LogDoor Statistics: Summary ***This line is replaced with Heading.txt *** 
Summary Prepared:       06/20/96 06:54
Site:   site1

Daily Totals

Date    Hits    Bytes   Errors

06/01/96        5       26123     0
etc.

Totals  5       26123    0

Sample reports are available on the LogDoor Web pages.

Heading files

LogDoor's summary reports will include text in files named Heading.html and Heading.txt if such files are found in the same folder as the task file when the reports are written. The text in files Heading.html and Heading.txt will replace the line indicated above in the HTML- and text-formatted reports respectively. Sample Heading.html and Heading.txt files are included with LogDoor.

Back to Table of Contents
Back to Appendix 1